Update README.md
This commit is contained in:
parent
ffb0a5b087
commit
095f35c934
1 changed files with 8 additions and 17 deletions
25
README.md
25
README.md
|
|
@ -58,23 +58,14 @@ Submit an [issue](https://github.com/DannyDannyDanny/gitmoji/issues) (or [Pull R
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
### Setup Server Management
|
* **Setup Server Management**
|
||||||
* Python set on [Ubuntu Server](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-programming-environment-on-an-ubuntu-20-04-server)
|
* Python set on [Ubuntu Server](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-programming-environment-on-an-ubuntu-20-04-server)
|
||||||
|
* **Setup Version Control**
|
||||||
### Setup Version Control
|
* Connect to your repos using [ssh](https://stackoverflow.com/a/65415202/5684214). when possible
|
||||||
* Install and use [pre-commit hooks](https://pre-commit.com/) on your dev machine
|
* Install and use [pre-commit hooks](https://pre-commit.com/) on your dev machine
|
||||||
* Setup [Travis-CI build testing](https://docs.travis-ci.com/user/customizing-the-build/#building-specific-branches)
|
* Setup [Travis-CI build testing](https://docs.travis-ci.com/user/customizing-the-build/#building-specific-branches)
|
||||||
|
* **Documentation**
|
||||||
### Oneliner install and run
|
* Install & Run section (docker one-liner)
|
||||||
When using git repositories, connect with [ssh](https://stackoverflow.com/a/65415202/5684214).
|
|
||||||
|
|
||||||
The README for your project should contain a one-liner code that dowloads, installs and runs a mini-test.
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/user/repo.git cool-repo && cd cool-repo
|
|
||||||
pipenv install
|
|
||||||
pipenv run python .
|
|
||||||
#cd .. && rm -rf cool-user-repo-online
|
|
||||||
```
|
|
||||||
|
|
||||||
## Develop
|
## Develop
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue