Skip to content

README.md

Latest commit

 

History

History
85 lines (67 loc) · 2.36 KB

README.md

File metadata and controls

85 lines (67 loc) · 2.36 KB

1. General info

This project is <!prj_name!> implementation for python. I use this <!prj_name!> for: <!...!>

This timer is created to incorporate two distinctive features:

  1. ...
  2. ...

2. Downloading the Repository

To download the repository, you have a few options

2.1. Clone the Repository via git

If you have Git installed on your system, you can clone the repository using
the following command in your terminal or command prompt:

$ REPO_URL='https://github.com/linxuil/<!prj_name!>.git&&\
git clone "${REPO_URL}" 'pomow'

This will create a local copy of the repository on your machine.

2.2. Download as ZIP file

Alternatively, you can download the repository as a ZIP file.
Simply navigate to the repository's page here and click on the "Code" button.
Then select "Download ZIP" to save the ZIP file to your computer.
After downloading, extract the contents of the ZIP file to access the repository files.

3. Usage

3.1. Without install module

Try use python script via cmd without install:

$ cd <'prj_folder'>

<!...!>

3.2. PIP module istall

You can install via pip in venv:

# Pull repo
$ REPO_URL='https://github.com/linxuil/<!prj_name!>'&&\
git clone "${REPO_URL}" '<!prj_name!>'&&\
cd <!prj_name!>

# Install venv if needed
$ sudo apt install python3-venv

# Create and activate venv in directory "venv"
$ VENV_DIR_NAME='venv'&&\
python3 -m venv "${VENV_DIR_NAME}"&&\
source venv/bin/activate

# Install module
$ pip install -e .

# Try use console command
$ <!prj_name!> <!...!>

Then you need exit from venv

$ deactivate

4. Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/YouFeature)
  3. Write any changes in code
  4. Add changes to index (git add -A)
  5. Commit your Changes (git commit -m 'You description')
  6. Push to the Branch (git push origin feature/YouFeature)
  7. Open a Pull Request on github

5. License

Distributed under the MIT License. See LICENSE.md for more information.

6. Contact

linxuil - linxuil.g@gmail.com

Project Link: https://github.com/linxuil/<!prj_name!>