Skip to content

Latest commit

 

History

History
122 lines (86 loc) · 2.12 KB

README.md

File metadata and controls

122 lines (86 loc) · 2.12 KB


Markdownify
Elixir For Everyone

Installation Steps • License

Installation Steps

Follow the steps below to install and set up the project.

Step 1: Install Dependencies

Ensure that the following tools are installed on your system:

  • RubyGems (gem)
  • Bundler
  • Make

You can check if they are installed by running:

gem --version
bundler --version
make --version

If any of these tools are not installed, you can install them using the following commands:

For RubyGems and Bundler:

  1. Install Ruby (if not already installed):

    • On macOS: 
      brew install ruby
    • On Ubuntu: 
      sudo apt-get install ruby-full

  2. Install Bundler:

    gem install bundler

For Make:

  • On macOS: 
    brew install make
  • On Ubuntu: 
    sudo apt-get install build-essential

After ensuring that all dependencies are installed, you can run:

make install
bundle install

Step 2: Clone the Repository

Clone the repository and navigate into the project directory:

git clone https://github.com/Elixir-For-Everyone/Elixir-For-Everyone
cd Elixir-For-Everyone

Step 3: Run the Installation Script

Execute the installation script to set up the project:

./install.sh

Step 4: Generate Output Formats

To generate book you can use

  • make all

Alternatively

You can generate different output formats using the following commands:

  • To generate an EPUB file:

    make epub

  • To generate a PDF file:

    make pdf

  • To generate HTML files:

    make html

License

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/3.0 or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.