Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md in versions and branches #491

Merged
merged 1 commit into from
Dec 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 31 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,31 @@

Lrama is LALR (1) parser generator written by Ruby. The first goal of this project is providing error tolerant parser for CRuby with minimal changes on CRuby parse.y file.

* [Features](#features)
* [Installation](#installation)
* [Usage](#usage)
* [Versions and Branches](#versions-and-branches)
* [Supported Ruby version](#supported-ruby-version)
* [Development](#development)
* [How to generate parser.rb](#how-to-generate-parserrb)
* [Test](#test)
* [Call-stack Profiling Lrama](#call-stack-profiling-lrama)
* [Memory Profiling Lrama](#memory-profiling-lrama)
* [Build Ruby](#build-ruby)
* [Release flow](#release-flow)
* [License](#license)
- [Lrama](#lrama)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Versions and Branches](#versions-and-branches)
- [v0\_7 (`master` branch)](#v0_7-master-branch)
- [v0\_6 (`lrama_0_6` branch)](#v0_6-lrama_0_6-branch)
- [v0\_5 (`lrama_0_5` branch)](#v0_5-lrama_0_5-branch)
- [v0\_4 (`lrama_0_4` branch)](#v0_4-lrama_0_4-branch)
- [Supported Ruby version](#supported-ruby-version)
- [Development](#development)
- [How to generate parser.rb](#how-to-generate-parserrb)
- [Test](#test)
- [Call-stack Profiling Lrama](#call-stack-profiling-lrama)
- [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby)
- [2. Enable Profiler](#2-enable-profiler)
- [3. Run Lrama](#3-run-lrama)
- [4. Generate Flamegraph](#4-generate-flamegraph)
- [Memory Profiling Lrama](#memory-profiling-lrama)
- [1. Create parse.tmp.y in ruby/ruby](#1-create-parsetmpy-in-rubyruby-1)
- [2. Enable Profiler](#2-enable-profiler-1)
- [3. Run Lrama](#3-run-lrama-1)
- [Build Ruby](#build-ruby)
- [Release flow](#release-flow)
- [License](#license)

## Features

Expand Down Expand Up @@ -73,9 +85,13 @@ Enter the formula:

## Versions and Branches

### v0_6 (`master` branch)
### v0_7 (`master` branch)

This branch is for Ruby 3.4. `lrama_0_6` branch is created from this branch, once Ruby 3.4 is released.
This branch is for Ruby 3.5. `lrama_0_7` branch is created from this branch, once Ruby 3.5 is released.

### v0_6 (`lrama_0_6` branch)

This branch is for Ruby 3.4.

### v0_5 (`lrama_0_5` branch)

Expand Down
Loading