diff --git a/README.en.md b/README.en.md index 02550da61..5d0dcebcd 100644 --- a/README.en.md +++ b/README.en.md @@ -30,25 +30,9 @@ We encourage our colleagues not to stand aside and to support this letter. # How to sign -You can do this by creating a file with a random name (preferably complex) in the `signed` folder. Put the following lines in the file (each line is a separate person): +You can sign this letter by creating file with random name in `signed` directory. +Put the following lines in the file (each line represents a single person): ``` -Last Name First Name | Position, company +Name Surname | Position, company ``` - -## Linux / MacOS / Cygwin (git bash) - -```bash -# Here YOUR_FORK - your fork of this repository -git clone ${YOUR_FORK} -cd case-212 -# YOUR_GITHUB_USERNAME - username on github, such naming of branch is optional, -# you can name your branch however you want, but don't forget to change git push command as well! -git checkout -b signature/${YOUR_GITHUB_USERNAME} -cd signed -# YOUR_SURNAME - surname, YOUR_NAME - first name, POSITION - position at your company, COMPANY - your company -echo "${YOUR_SURNAME} ${YOUR_NAME} | ${POSITION}, ${COMPANY}" > $(uuidgen) -git commit -a -m 'Signature from ${YOUR_GITGUB_USERNAME}' -git push origin signature/${YOUR_GITHUB_USERNAME} -# time to create pull-request! -``` - +More verbose manual is available [here](./manual.en.md) diff --git a/manual.en.md b/manual.en.md index 9fbd6cd6e..a482f69a3 100644 --- a/manual.en.md +++ b/manual.en.md @@ -1,8 +1,8 @@ # How to sign -You can do this by creating a file with a random name (preferably complex) in the `signed` folder. Put the following lines in the file (each line is a separate person): +You can sign this letter by creating a file with a random name (an easy way to create a unique filename is to use *[GUID generator](https://www.guidgenerator.com/online-guid-generator.aspx)*) in the `signed` folder. Put the following lines in the file (each line represents a single person): ``` -Last Name First Name | Position, company +Name Surname | Position, company ``` ## Linux / MacOS / Cygwin (git bash) @@ -16,7 +16,7 @@ cd case-212 git checkout -b signature/${YOUR_GITHUB_USERNAME} cd signed # YOUR_SURNAME - surname, YOUR_NAME - first name, POSITION - position at your company, COMPANY - your company -echo "${YOUR_SURNAME} ${YOUR_NAME} | ${POSITION}, ${COMPANY}" > $(uuidgen) +echo "${YOUR_NAME} ${YOUR_SURNAME} | ${POSITION}, ${COMPANY}" > $(uuidgen) git commit -a -m 'Signature from ${YOUR_GITHUB_USERNAME}' git push origin signature/${YOUR_GITHUB_USERNAME} # time to create pull-request! diff --git a/pre-readme.md b/pre-readme.md index 412c2259f..a358d5d3c 100644 --- a/pre-readme.md +++ b/pre-readme.md @@ -32,7 +32,12 @@ # Как подписаться -Смотрите [инструкцию](./manual.md) +Вы можете оставить подпись создав файл со случайным именем в директории `signed`. +В этом файле напишите строки следующего формата (каждая строка отдельный человек): +``` +Фамилия Имя | Должность, компания +``` +Более подробная инструкция доступна [здесь](./manual.md) ***