From e0bc4f4d56e00e810c3fb75e3fee2e6600a53bd9 Mon Sep 17 00:00:00 2001 From: Elias Estrada Date: Fri, 10 May 2024 12:53:10 -0700 Subject: [PATCH] Update README.md --- docs/README.md | 41 +++++++++++++++++------------------------ 1 file changed, 17 insertions(+), 24 deletions(-) diff --git a/docs/README.md b/docs/README.md index 70fcd51..18e6d5a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,31 +1,24 @@ # ForSure Language (FSH) -ForSure is a language designed to describe and document file structures in a clear and concise manner. It uses a simple, human-readable syntax to represent directories, files, and their relationships. This document serves as an introductory guide to the main features of ForSure and how to utilize them in your projects. +ForSure is a language designed to simplify projects by using a flat-file-like structured language/compiler/cli/converter system. It allows you to describe and document file structures in a clear and concise manner, similar to how you would write a Dockerfile for a container. ForSure uses a simple, human-readable syntax to represent directories, files, and their relationships. ## Getting Started -To get started with ForSure, clone this repository and review the sample .fs files included. You can write your ForSure definitions using any text editor. +To start using ForSure, clone this repository and review the sample .fs files included. You can write your ForSure definitions using any text editor. ## Features -Hierarchical Structure: Mimics the natural file system's hierarchy. - -Comments and Annotations: Offers inline commenting and metadata association. - -@import Directives: Facilitates file inclusion for reusable structures. - -Custom Attributes: Extends elements with user-defined attributes like permissions and sizes. - -Readable and Simple: A clean syntax that prioritizes user understanding and ease of use. +- **Hierarchical Structure:** Mimics the natural file system's hierarchy. +- **Comments and Annotations:** Offers inline commenting and metadata association. +- **@import Directives:** Facilitates file inclusion for reusable structures. +- **Custom Attributes:** Extends elements with user-defined attributes like permissions and sizes. +- **Readable and Simple:** A clean syntax prioritizing user understanding and ease of use. ## Writing Your First ForSure File -Here is a basic example of what a .fs file looks like: +Here's a basic example of what a .fs file looks like: -Diff -Copy -Insert -New +``` root: # Main source code directory - src: @@ -42,18 +35,18 @@ root: - theme.css # Documentation file - README.md +``` ## Contributing -Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make to improve ForSure are greatly appreciated. Refer to the CODE_OF_CONDUCT.md file for more information about contributing to this project. - +Contributions to ForSure are greatly appreciated. Any improvements or suggestions are welcome. Please refer to the CODE_OF_CONDUCT.md file for guidelines on contributing to this project. -## Fork the Project +### Fork the Project -Create your Feature Branch (git checkout -b feature/AmazingFeature) -Commit your Changes (git commit -m 'Add some AmazingFeature') -Push to the Branch (git push origin feature/AmazingFeature) -Open a Pull Request +1. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +2. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +3. Push to the Branch (`git push origin feature/AmazingFeature`) +4. Open a Pull Request ## License @@ -61,7 +54,7 @@ Distributed under the MIT License. See LICENSE for more information. ## Contact -Your Name - @your_twitter +Your Name - @your_twitter_handle Project Link: https://github.com/your_repo/ForSure Feel free to customize the README.md to better suit the specifics of your project or personal information.