From 7d9f29c0e91a82f9bca2158ecd2fa1b817441c47 Mon Sep 17 00:00:00 2001 From: Daniel Wilczak <44122838+danielwilczak101@users.noreply.github.com> Date: Mon, 1 Feb 2021 12:12:18 -0500 Subject: [PATCH] Update README.md --- README.md | 57 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 6a8e7b6..2da1dd6 100644 --- a/README.md +++ b/README.md @@ -45,63 +45,10 @@ Chromosome - 8 [5][8][8][6][10][10][5][7][2][7] / Fitness = 2 Chromosome - 9 [7][2][8][10][3][5][5][8][1][7] / Fitness = 2 ``` +## Issues +We would love to know if your having any issues. Please start a new issue on the [Issues Page](https://github.com/danielwilczak101/EasyGA/issues). -# How Testing works - -### Getting started with testing - -```bash -pip3 install pytest -``` - -### Navigate to your EasyGA folder and run: -```bash -python3 -m pytest -``` - -#### Output -```bash -============================================= test session starts ========================= -platform darwin -- Python 3.8.6rc1, pytest-6.0.2, py-1.9.0, pluggy-0.13.1 -rootdir: /Users/github/EasyGA -collected 2 items - -test_EasyGA.py .. [100%] - -============================================== 2 passed in 0.04s ========================== -``` - - - - -This is only an example and we will create hundreds of tests so this list will become bigger and bigger. - - -## Developing EasyGA: -### If you know how to use Github and git ignore this section. - -### Getting started with development -To work together we plan on using github and the git framework. This is made easy with the Atom software. - -Download Atom for whatever OS you have. -https://atom.io/ - -Use the github tab to pull the github repository. Its self explanitory. - -Use the run_testing.py file inside the src folder to run your code and test while we build the package. - -## Upload to PyPi - -1. Change version number to whatever plus 1 -2. Rename "src" folder to "EasyGA" -3. Run these two commands -``` -python setup.py bdist_wheel sdist // Build the package for publishing -twine upload dist/* // Upload package to PyPI -``` - -The second command requires a username and password. ## Other options