📝 add oneline / buildscript documentation
This commit is contained in:
parent
95594c3acd
commit
3e9ec3c0c5
1 changed files with 12 additions and 1 deletions
11
README.md
11
README.md
|
|
@ -7,6 +7,7 @@
|
||||||
## Repo Roadmap
|
## Repo Roadmap
|
||||||
* [x] 2021Q1: ~Gitmoji -> (general) Methodology~ :white_check_mark:
|
* [x] 2021Q1: ~Gitmoji -> (general) Methodology~ :white_check_mark:
|
||||||
* [ ] 2021Q2: Development Methodology
|
* [ ] 2021Q2: Development Methodology
|
||||||
|
* [x] Oneliner run commands
|
||||||
* [ ] Git (Branching, Merging and Pull Requests)
|
* [ ] Git (Branching, Merging and Pull Requests)
|
||||||
* [ ] [OpenStack](https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide): Linting and Pre-commit Hooks
|
* [ ] [OpenStack](https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide): Linting and Pre-commit Hooks
|
||||||
* [ ] 2021Q3: Organize other methodology better
|
* [ ] 2021Q3: Organize other methodology better
|
||||||
|
|
@ -40,6 +41,16 @@ In your commit message use the format `:gitmoji: <commit message>`. Only propper
|
||||||
Missing a gitmoji? Get [inspiration](https://gist.github.com/rxaviers/7360908).
|
Missing a gitmoji? Get [inspiration](https://gist.github.com/rxaviers/7360908).
|
||||||
Submit an [issue](https://github.com/DannyDannyDanny/gitmoji/issues) (or [Pull Request](https://github.com/DannyDannyDanny/gitmoji/pulls)).
|
Submit an [issue](https://github.com/DannyDannyDanny/gitmoji/issues) (or [Pull Request](https://github.com/DannyDannyDanny/gitmoji/pulls)).
|
||||||
|
|
||||||
|
## Oneliner install and run
|
||||||
|
The readme must contain a one-liner code that
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/user/repo.git cool-user-repo-oneline && cd cool-user-repo-oneline
|
||||||
|
pipenv install
|
||||||
|
pipenv run python .
|
||||||
|
#cd .. && rm -rf cool-user-repo-online
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Git Branching
|
## Git Branching
|
||||||
> Coming soon! 🚧
|
> Coming soon! 🚧
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue