Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
uptudev committed Feb 19, 2024
1 parent 276f2e8 commit 2756faf
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 24 deletions.
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,10 @@ This will build your executable in the `./target/release/` folder, with the file

The base initializer is run simply via `pi`, but if the project name and language are given, this can streamline the initialization process.

**Tips:**

* Break down instructions into logical steps.
* Use bullet points for succinct explanations.
* Consider creating a separate "Getting Started" guide for beginners.

## Contributing

**Outline your contribution guidelines.** Explain how users can contribute to your project, whether through code, bug reports, or documentation improvements. Specify preferred code style, pull request format, and testing procedures.
This shouldn't really need too much in terms of collaboration, but feel free to send in a pull request if you have a feature you feel that I should add!

## License

**Specify the license under which your project is distributed.** Use clear and concise language, and link to the full license text in the `LICENSE` file.

## Additional Information

**Include any other relevant information you want to share.** This could be links to related projects, documentation, support channels, or your contact information.

**Remember:**

* Keep your README.md file concise and focused.
* Use clear headings, formatting, and visuals for readability.
* Update your README.md file regularly to reflect changes in your project.

This code is licensed under the [MIT License](https://github.com/uptudev/pi/blob/main/LICENSE).
6 changes: 3 additions & 3 deletions src/libs/base.rs
Original file line number Diff line number Diff line change
Expand Up @@ -212,9 +212,9 @@ pub fn gen_help_template() -> String {
const VER_LEN: usize = env!("CARGO_PKG_VERSION").len() - 5;
const BASE: &'static str = "\
{before-help}
\x1b[0;35m┍━━━━━━━━┑
\x1b[1;95;4m{name}\x1b[0;95;4m {version}\x1b[0;35m│
┕━━━━━━━━┙\x1b[0m
\x1b[0;35m┍━━━━━━━━
\x1b[1;95m{name}\x1b[0;37m v{version}\x1b[0;35m│
┕━━━━━━━━\x1b[0m
{author-with-newline}
{about-with-newline}
{usage-heading} {usage}
Expand Down
4 changes: 2 additions & 2 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ fn styles() -> Styles {
Styles::styled()
.header(AnsiColor::Yellow.on_default() | Effects::BOLD)
.usage(AnsiColor::Yellow.on_default() | Effects::BOLD)
.literal(AnsiColor::Blue.on_default())
.literal(AnsiColor::BrightBlue.on_default())
.placeholder(AnsiColor::Green.on_default())
}

/// The --help string
const HELP: &'static str = "\x1b[0;1;92;4mPi\x1b[0m is a CLI \x1b[34mproject initializer\x1b[0m which uses per-language build tools to create project directories populated with a full project template.";
const HELP: &'static str = "\x1b[0;1;95;4mPi\x1b[0m is a CLI \x1b[94mproject initializer\x1b[0m which uses per-language build tools to create project directories populated with a full project template.";

/// The arguments to be pushed to the rest of the program
#[derive(Parser, Debug)]
Expand Down

0 comments on commit 2756faf

Please sign in to comment.