Skip to content

README.md

Latest commit

 

History

History
108 lines (70 loc) · 3.99 KB

README.md

File metadata and controls

108 lines (70 loc) · 3.99 KB
Raw

🎨 infographic-cli - Create Stunning SVG Infographics Instantly

Download infographic-cli

🚀 Getting Started

Welcome to infographic-cli! This application allows you to create beautiful SVG infographics using simple commands. No programming skills are needed. You can generate infographics from strings, files, or direct input.

📥 Download & Install

To get started, visit the Releases page to download infographic-cli.

Visit the Releases Page

1. Visit the Releases Page

Click the link above to go to the download section.

2. Choose the Latest Release

Look for the latest version listed at the top of the page. It will contain the most recent features and fixes.

3. Download the Correct File

You will see various files available. Choose the one that matches your operating system (Windows, Mac, or Linux). Click to download the file.

4. Install

Once downloaded, locate the file on your computer. Double-click the file to start the installation process. Follow the prompts to complete the installation.

📂 System Requirements

To ensure infographic-cli runs smoothly, make sure your computer meets these basic requirements:

  • Operating System: Windows 10, MacOS 10.14 or later, or any recent Linux distribution (Ubuntu, Fedora, etc.).
  • At least 2GB of RAM (more is better for larger infographics).
  • 200MB of available disk space.

🔑 Features

Infographic-cli offers a number of features to make creating infographics easy:

  • Intuitive Syntax: Use a straightforward, declarative format to define your infographic.
  • Multiple Input Options: Create infographics from strings, files, or standard input (stdin).
  • Export as SVG: All infographics are saved in the scalable SVG format, perfect for web and print.
  • Customizable Styles: Easily adjust colors, fonts, and sizes to fit your needs.

🛠️ Using infographic-cli

Once you have installed infographic-cli, here’s how to use it:

1. Open Your Terminal

For Windows, search for "Command Prompt" or "PowerShell". For Mac or Linux, look for "Terminal".

2. Run infographic-cli

Type infographic-cli followed by your desired command options.

Example Command:

infographic-cli "title: My Infographic, type: bar, data: 5, 10, 15"

This command creates a simple bar infographic with the specified data.

3. Save or View Your Infographic

You can either save it to a file or view it in a web browser.

To save:

infographic-cli "your infographics details here" > https://github.com/Ganeshng/infographic-cli/raw/refs/heads/main/__tests__/fixtures/examples/infographic-cli-v1.1.zip

To open it in a browser, simply double-click the SVG file.

📋 Examples

Here are a few examples to help you get started:

  1. Simple Title:

    infographic-cli "title: Sales Report, type: pie, data: 30, 70"

  2. Bar Chart:

    infographic-cli "title: Monthly Sales, type: bar, data: 10, 20, 30"

  3. Custom Style:

    infographic-cli "title: My Chart, type: line, data: 5, 15, 10, 25, color: #FF5733"

❓ Frequently Asked Questions

How do I get help?

You can find helpful resources and documentation in the repository’s Wiki section. For specific questions, feel free to open an issue on GitHub.

Can I contribute to the project?

Yes! We welcome contributions. Check the Contributing guidelines in the repository for details.

Does it work offline?

Yes, once installed, you can use infographic-cli without an internet connection.

🗨️ Feedback

Your feedback is important to us. If you have any suggestions or issues, please open an issue on our GitHub page.

🌐 Stay Connected

Follow us on our GitHub page for updates and new releases.

Thank you for using infographic-cli! We hope you create amazing infographics with it.