Create README.md

README.md

@@ -0,0 +1,130 @@
+# PrintLayout
+
+PrintLayout is a command-line tool that prints the directory structure of a specified folder in a tree format. It is designed to be simple, fast, and customizable.
+
+## Installation
+
+### Option 1: Go Install
+To install PrintLayout, run:
+
+```bash
+go install github.com/Ahmedhossamdev/PrintLayout/cmd/main.go
+```
+
+This will install the printlayout executable to your $GOPATH/bin directory. Make sure $GOPATH/bin is in your PATH environment variable.
+
+### Option 2: Download Pre-Built Binaries
+
+Download the pre-built binary for your operating system from the [Releases page](#).
+
+#### Linux/macOS
+
+1. Download the binary for your platform (e.g., `printlayout-linux-amd64` or `printlayout-darwin-amd64`).
+2. Make the binary executable:
+   ```bash
+   chmod +x printlayout-linux-amd64
+   ```
+3. Move the binary to a directory in your `PATH` (e.g., `/usr/local/bin`):
+   ```bash
+   sudo mv printlayout-linux-amd64 /usr/local/bin/printlayout
+   ```
+
+#### Windows
+
+1. Download the binary for your platform (e.g., `printlayout-windows-amd64.exe`).
+2. Move the binary to a directory in your `PATH` (e.g., `C:\Windows\System32`).
+
+## Usage
+
+### Print the Directory Structure
+
+To print the directory structure of the current folder:
+
+```bash
+printlayout
+```
+
+To print the directory structure of a specific folder:
+
+```bash
+printlayout /path/to/your/folder
+```
+
+### Example Output
+
+```bash
+$ printlayout /path/to/your/folder
+printLayout/
+├── cmd/
+│   └── main.go
+├── go.mod
+├── internal/
+│   └── utils/
+│       └── utils.go
+└── pkg/
+    └── printer/
+        ├── printer.go
+        └── printer_test.go
+```
+
+## Development
+
+### Run the Project in Development
+
+To run the project during development without installing it:
+
+```bash
+go run ./cmd/main.go /path/to/your/folder
+```
+
+### Run Tests
+
+To run the tests:
+
+```bash
+go test -v ./...
+```
+
+### Build the Project
+
+To build the project:
+
+```bash
+go build -o printlayout ./cmd/main.go
+```
+
+This will create an executable named printlayout in your project directory.
+
+## Future Improvements (TODOs)
+
+Here are some ideas for future improvements to the project:
+
+1. Advanced Command-Line Options:
+   - Add support for limiting the depth of the directory tree (e.g., --depth 2).
+   - Add an option to include hidden files and directories (e.g., --hidden).
+   - Add an option to ignore files and directories listed in .gitignore (e.g., --ignore-gitignore).
+
+2. Customizable Output:
+   - Add support for customizing the tree symbols (e.g., --symbols=ascii for ASCII-only output).
+   - Add support for exporting the directory structure to a file (e.g., --output tree.txt).
+
+3. Performance Improvements:
+   - Optimize the directory traversal for large directories.
+   - Add support for parallel processing of directories.
+
+## Contributing
+
+Contributions are welcome! If you'd like to contribute, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Make your changes and write tests if applicable.
+4. Submit a pull request with a detailed description of your changes.
+
+## License
+
+This project is open-source and available under the [MIT License](LICENSE).
+
+## Acknowledgments
+
+- Built with Go for simplicity and performance.