From 88552172a55515def60b67e58c5f4a51c6c61053 Mon Sep 17 00:00:00 2001 From: qaidjoharj53 Date: Thu, 5 Oct 2023 00:37:45 +0530 Subject: [PATCH] documentation update --- README.md | 66 +++++++++++++++------------ __pycache__/menu_bar.cpython-311.pyc | Bin 2119 -> 2126 bytes base_window.py => main.py | 0 3 files changed, 36 insertions(+), 30 deletions(-) rename base_window.py => main.py (100%) diff --git a/README.md b/README.md index f358f15..9b559c9 100644 --- a/README.md +++ b/README.md @@ -10,48 +10,54 @@ "dw-code" is an open-source Integrated Development Environment (IDE) designed to provide the style and look of Visual Studio Code (VS Code) while offering the power and functionality of popular C/C++ IDEs like Dev C++ and Code::Blocks. It's built using Python and the tkinter library. This repository is open for **Hacktoberfest 2023!!** ## TODO: -Before opening any issue refer to [TODO.md](https://github.com/rohitagr0310/dw-code/TODO.md + +Before opening any issue refer to [TODO.md](https://github.com/rohitagr0310/dw-code/blob/main/TODO.md) + ## Features -- VS Code-inspired user interface. -- Powerful code editing capabilities. -- Built-in menu bar for easy access to common functions. -- Syntax highlighting for multiple programming languages. -- Support for code autocompletion. -- Integrated file management and project organization. -- Extensible through plugins and extensions. -- Cross-platform, works on Windows, macOS, and Linux. +- VS Code-inspired user interface. +- Powerful code editing capabilities. +- Built-in menu bar for easy access to common functions. +- Syntax highlighting for multiple programming languages. +- Support for code autocompletion. +- Integrated file management and project organization. +- Extensible through plugins and extensions. +- Cross-platform, works on Windows, macOS, and Linux. ## Getting Started To get started with "dw-code," follow these steps: -1. Clone the repository: +1. Star the repository ⭐ + +2. Fork the repository 🍴 + +3. Clone the repository: + + ```bash + git clone https://github.com/yourusername/dw-code.git + cd dw-code + ``` - ```bash - git clone https://github.com/yourusername/dw-code.git - cd dw-code - ``` +4. Create a virtual environment (optional but recommended): -2. Create a virtual environment (optional but recommended): + ```bash + python -m venv venv + source venv/bin/activate # On Windows, use `venv\Scripts\activate` + ``` - ```bash - python -m venv venv - source venv/bin/activate # On Windows, use `venv\Scripts\activate` - ``` +5. Install dependencies: -3. Install dependencies: + ```bash + pip install -r requirements.txt + ``` - ```bash - pip install -r requirements.txt - ``` +6. Run the application: -4. Run the application: + ```bash + python main.py + ``` - ```bash - python main.py - ``` - ## Contributing Contributions are welcome! If you'd like to contribute to "dw-code," please check out our [contribution guidelines](CONTRIBUTING.md). @@ -62,8 +68,8 @@ If you encounter any issues or have questions, please open an [issue](https://gi ## Acknowledgments -- Thanks to the Python community for creating and maintaining tkinter. -- Special thanks to the VS Code and C/C++ IDE communities for inspiration. +- Thanks to the Python community for creating and maintaining tkinter. +- Special thanks to the VS Code and C/C++ IDE communities for inspiration. --- diff --git a/__pycache__/menu_bar.cpython-311.pyc b/__pycache__/menu_bar.cpython-311.pyc index ac87da3d1b7d4031ec173e28523015e126f26b74..571ec7a9e4183e00c3fbfeffdeb8e6950313417e 100644 GIT binary patch delta 106 zcmX>ua87`GIWI340}#w#BfF7XjnT-}*(xTqIJKxarZ6!xB`d}yKe;qFHLs*N#yzvd zqckbTBQd!oKPj~+Ew#8r*T}%gcyj_{6dPm5na9n_UIWI340}$~1lG(_u#;EV)Y!wq)oLW>IQ