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.

Sign up for GitHub

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

getting started edits #595

Merged
merged 2 commits into from
Sep 2, 2024
Merged

getting started edits #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2772dca
Made getting started first section
Otsar-Raikou Sep 1, 2024
9f40278
Update getting_started.md
Otsar-Raikou Sep 1, 2024
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
3 changes: 2 additions & 1 deletion docs/docs/icicle/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Overview

This guide explains how to start using ICICLE, including installation steps. The typical workflow for a user is:
This guide will walk you through the entire process of building, testing, and installing ICICLE using your preferred programming language—C++, Rust, or Go. Whether you're deploying on a CPU or leveraging CUDA for accelerated performance, this guide provides comprehensive instructions to get you started. It also outlines the typical workflow for a user, including key installation steps:


1. **Install ICICLE or build it from source**: This is explained in this guide. For building from source, refer to the [Build from Source page](./build_from_source.md).
2. **Follow the [Programmer’s Guide](./programmers_guide/general.md)**: Learn how to use ICICLE APIs.
Expand Down
34 changes: 18 additions & 16 deletions docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,22 @@ module.exports = {
},
collapsed: false,
items: [
{
type: "category",
label: "Getting started",
link: {
type: `doc`,
id: "icicle/getting_started",
},
collapsed: false,
items: [
{
type: "doc",
label: "Build ICICLE from source",
id: "icicle/build_from_source",
},
],
},
{
type: "category",
label: "Architecture overview",
Expand Down Expand Up @@ -45,22 +61,6 @@ module.exports = {
label: "ICICLE libraries",
id: "icicle/libraries",
},
{
type: "category",
label: "Getting started",
link: {
type: `doc`,
id: "icicle/getting_started",
},
collapsed: false,
items: [
{
type: "doc",
label: "Build ICICLE from source",
id: "icicle/build_from_source",
},
],
},
{
type: "category",
label: "Programmers guide",
Expand Down Expand Up @@ -298,3 +298,5 @@ module.exports = {
}
],
};

};
Loading