Skip to content

Commit

Permalink
Added distribution pacages, updated gitignore and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
erikkamph committed Jul 8, 2022
1 parent 9d1f507 commit 89e1f92
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ __pycache__/
.Python
build/
develop-eggs/
dist/
# dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
# sdist/
var/
wheels/
share/python-wheels/
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,22 +86,23 @@ When installing in your own project, be sure to follow one of following steps:

#### Cloning and installing
1. Change directory to your own project where you are going to use the module
2. `git clone https://github.com/erikkamph/menu`
2. `git clone https://github.com/erikkamph/project_menu`
3. Add following lines to the file(s) where you are going to use the menu:
```python
from data import MenuItem, ItemSingleSelection, ItemMultiSelection
from menu import ApplicationMenu
from project_menu.src.menu_zerobeef.data import MenuItem, ItemSingleSelection, ItemMultiSelection
from project_menu.src.menu_zerobeef.menu import ApplicationMenu
```
4. See [example.py](/src/menu_zerobeef/example.py) for examples on how to setup the menu
5. Add `/menu/` to a `.gitignore` file as it should not be pushed to your own git repository, do this for every `.gitignore`.
5. Add `/project_menu/` to a `.gitignore` file as it should not be pushed to your own git repository, do this for every `.gitignore`.

#### Using PyPI
This method is not yet supported.

#### Creating a submodule in project
1. Enter the same git directory as your own project you want to add this to
2. Execute following `git submodule add https://github.com/erikkamph/menu`. This will add the project as a submodule for your project.
2. Execute following `git submodule add https://github.com/erikkamph/project_menu`. This will add the project as a submodule for your project.
3. Check that it has been added by running `git status`
4. Follow installation steps from 3 and forward under [Cloning and installing](#cloning-and-installing)

##### Important regarding submodules
None of the code will follow for users of your project when using submodules.
Expand Down
Binary file added dist/menu_zerobeef-0.1-py3-none-any.whl
Binary file not shown.
Binary file added dist/menu_zerobeef-0.1.tar.gz
Binary file not shown.

0 comments on commit 89e1f92

Please sign in to comment.