Commit a36a837c authored by bhnvi dubey's avatar bhnvi dubey
Browse files

readme: linting and spellcheck

removes the rest of the faulty links, wraps the lines properly,
and fixes @dhaynes spelling from commit 0675ce93.
parent 6d73faa6
Pipeline #1265 passed with stage
in 1 minute and 15 seconds
......@@ -113,11 +113,11 @@ environments across machines.
Installing Docker on your system:
- For macOS: [https://docs.docker.com/docker-for-mac/]()
- For Windows: [https://docs.docker.com/docker-for-windows/]()
- For your specific *nix distro: [https://docs.docker.com/engine/installation/]()
- For macOS: https://docs.docker.com/docker-for-mac/
- For Windows: https://docs.docker.com/docker-for-windows/
- For your specific \*nix distro: https://docs.docker.com/engine/installation/
Additionally, you will need to install docker-compose: [https://docs.docker.com/compose/install/]()
Additionally, you will need to install docker-compose: https://docs.docker.com/compose/install/
Next inside the `whats-open/` root directory run:
......@@ -135,7 +135,7 @@ If that doesn't work, try:
sudo docker-compose build
You should see that the server is running by going to [http://localhost:8000]()
You should see that the server is running by going to http://localhost:8000
in your browser. Any changes you make to your local file system will be mirrored in the server.
If you would like to log into the admin interface then use the following credentials:
......@@ -273,7 +273,7 @@ Now that everything is set-up you can run the server on your computer.
python3 manage.py runserver
Go to [http://127.0.0.1:8000/]() in your browser and you should see the website.
Go to http://127.0.0.1:8000/ in your browser and you should see the website.
Initially, there won't be any restaurants showing. You will need to add them to
the database.
......@@ -284,7 +284,7 @@ Run,
to create a superuser to use when signing in to the admin interface.
Go to [http://127.0.0.1:8000/admin/]() to add new Restaurant and Schedule objects
Go to http://127.0.0.1:8000/admin/ to add new Restaurant and Schedule objects
to your database.
With that, everything should be good to go!
......@@ -315,8 +315,8 @@ close issues with poor descriptions or who do not follow the standard.
## Coding style
You should adhere to the style of the repo code. Consistancy is key! PEP8
guidelines are strongly reccomended but not enforced at the time. Please comment your code, I will not accept commits that contain uncommented code.
You should adhere to the style of the repo code. Consistency is key! PEP8
guidelines are strongly recommended but not enforced at the time. Please comment your code, I will not accept commits that contain uncommented code.
## Getting Help
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment