From 60cbb96ba4f24bddd8e0bef21b37932e01ee2a18 Mon Sep 17 00:00:00 2001 From: "Jalith.c" Date: Sun, 7 Apr 2024 15:39:22 +0530 Subject: [PATCH] Added some explainations and features for find phrases --- README.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 3bbe8d2..d5479ac 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,43 @@ # Thank You -I would like to thank all of the contributors who are improving this project. I really appreciate your efforts. This project started when I was in college and I never thought it would turn into anything. Seeing all you guys add features and fix the errors that I couldn't is really encouraging. Thank you so much! +- I would like to thank all of the contributors who are improving this project. I really appreciate your efforts. This project started when I was in college and I never thought it would turn into anything. Seeing all you guys add features and fix the errors that I couldn't is really encouraging. Thank you so much! # OrganiseDesktop -Takes all the files on your desktop and put them in folders according to extensions. NO MORE MESSY DESKTOPS! +- Takes all the files on your desktop and put them in folders according to extensions. NO MORE MESSY DESKTOPS! At least not on the outside :) # Slack Channel invite link -Feel free to join the channel and contribute. If you have already had a PR merged, please join the [channel](https://join.slack.com/t/organisedesktop/shared_invite/enQtMzA2NTI2MTI0MzY4LWRlOWRjOGM0YTJmYjFiZGU3ZTUzM2M0MTA2N2U3MzljMmFhNGIyODlmZDg2N2E1Y2EwOWFiZjcxMzYzYjcyMTk). +- Feel free to join the our slack channel and contribute to our projects. +- If you have already had a PR merged, please join the [channel](https://join.slack.com/t/organisedesktop/shared_invite/enQtMzA2NTI2MTI0MzY4LWRlOWRjOGM0YTJmYjFiZGU3ZTUzM2M0MTA2N2U3MzljMmFhNGIyODlmZDg2N2E1Y2EwOWFiZjcxMzYzYjcyMTk). # Getting Started -The setup file is not yet configured (work in progress). To run the program, download +- The setup file is not yet configured (work in progress). To run the program, download the repo and install the required packages then run the `Clean.py` file. # Technologies Used -Python 3.7 +- Python 3.7 ### Python Libraries Used ### -beautifulsoup4 - 4.6.0 | certifi - 2018.1.18 | chardet - 3.0.4 | colorama - 0.3.9 | crontab - 0.22.0 | idna - 2.6 | py-stackexchange - 2.2.7 | requests - 2.18.4 +- beautifulsoup4 - 4.6.0 | certifi - 2018.1.18 | chardet - 3.0.4 | colorama - 0.3.9 | crontab - 0.22.0 | idna - 2.6 | py-stackexchange - 2.2.7 | requests - 2.18.4 six - 1.11.0 | urllib3 - 1.22 | urwid - 2.0.1 # Demo -![Screenshot](demo1.png) +- ![Screenshot](demo1.png) -The buttons are `Clean`, `Exit`, `Undo`, `Schedule`, `Remove Schedule` and do exactly as they are implied. +- The buttons are `Clean`, `Exit`, `Undo`, `Schedule`, `Remove Schedule` and do exactly as they are implied. -`Clean` - will move the files to the correct folder based on extension. If the folder does not exist, it will create one. -`Exit` - will close out of the program -`Undo` - undos where the files were placed in the folders when `Clean` was used -`Schedule` - schedules when the program will run every day in the users command line/ terminal -`Remove Schedule` - removes the previously established schedule +- `Clean` - will move the files to the correct folder based on extension. If the folder does not exist, it will create one. +- `Exit` - will close out of the program +- `Undo` - undos where the files were placed in the folders when `Clean` was used +- `Schedule` - schedules when the program will run every day in the users command line/ terminal +- `Remove Schedule` - removes the previously established schedule # Prerequisites ### Running a Virtual Environment ### -All the necessary packages are mentioned in `requirements.txt`. They can be installed by running `pip install -r requirements.txt` or using ``pipenv install`` and it will automatically detect the `requirements.txt` and setup an enviroment for you. For development purposes, I suggest you create a +- All the necessary packages are mentioned in `requirements.txt`. They can be installed by running `pip install -r requirements.txt` or using ``pipenv install`` and it will automatically detect the `requirements.txt` and setup an enviroment for you. For development purposes, I suggest you create a virtual environment or use a dependency manager like [pipenv](https://github.com/pypa/pipenv) to keep a clear state, separate from your own setup. To create a virual environment yourself in pipenv, follow the steps below: @@ -48,23 +49,23 @@ If the `pipenv install` does not work, insert the following `pipenv install -r r The `activate.sh` script has been provided to ensure a standard development environment. To create the environment if it doesn't already exist, or simply load it otherwise, run `source ./activate.sh` -You can also use docker in combination with pipenv, [here](https://github.com/dfederschmidt/docker-pipenv-sample) you have an example. +- You can also use docker in combination with pipenv, [here](https://github.com/dfederschmidt/docker-pipenv-sample) you have an example. ### Not Running from Virtual Environment ### If you do not want to create a virtual environment, just run the pip command above and ignore the following. Otherwise, the `activate.sh` script will handle the creation and loading of the virtual environment with all the necessary dependencies. Furthermore, once a new dependency is established, remove `requirements.txt` and please run `pip freeze > requirements.txt` to generate a new file that should be committed to version control. Python3 Instructions: -`python -m venv organise_desktop` +- `python -m venv organise_desktop` To activate it, run `source organise_desktop/bin/activate` ### Build from Source `$ git clone https://github.com/blavejr/OrganiseDesktop.git` -Navigate to the repo and run the following command: +- Navigate to the repo and run the following command: `$ pip install -r requirements.txt` # Contributing -Please read the [Contributing Guidlines](https://github.com/blavejr/OrganiseDesktop/blob/master/CONTRIBUTING.md) for details about pull requests, bug reports or opening an issue. +- Please read the [Contributing Guidlines](https://github.com/blavejr/OrganiseDesktop/blob/master/CONTRIBUTING.md) for details about pull requests, bug reports or opening an issue. Believe in the tech, use the tech, buy a dev coffee. Btc: 3GiHDAed4UFcE9itaVxQnTrKbW4Uw2kq3o