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

Add documentation in README and gemspec #512

Merged
merged 3 commits into from
Jan 18, 2025
Merged
Show file tree
Hide file tree
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
56 changes: 30 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,32 @@

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.

- [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)
- [How to Write a Type Signature](#how-to-write-a-type-signature)
- [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](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [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)
- [How to Write a Type Signature](#how-to-write-a-type-signature)
- [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 @@ -84,6 +84,10 @@ Enter the formula:
=> 9
```

## Documentation

https://ruby.github.io/lrama/ provides a comprehensive guide to Lrama's features and usage.

## Versions and Branches

### v0_7 (`master` branch)
Expand Down
2 changes: 1 addition & 1 deletion lrama.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Gem::Specification.new do |spec|

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = spec.homepage
spec.metadata["documentation_uri"] = spec.homepage
spec.metadata["documentation_uri"] = "https://ruby.github.io/lrama/"
spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"

Expand Down
Loading