From 1d7af55b8def1d822fd36632cc18538524ee0a42 Mon Sep 17 00:00:00 2001 From: Whitney Armstrong <warmstrong@anl.gov> Date: Mon, 25 Jan 2021 13:19:13 -0600 Subject: [PATCH] Updated readme - Took out gatsby template README contents. - Put dummy text. Needs more detail. --- README.md | 58 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 1fe94ed..3674d50 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,4 @@ -<p align="center"> - <img src="https://rocketseat-cdn.s3-sa-east-1.amazonaws.com/theme-docs.svg" alt="A illustration of file that is the @rocketseat/gatsby-theme-docs logo" width="100"> -</p> +# EIC Software Tutorial -<h2 align="center"> - Gatsby Starter: Rocket Docs -</h2> -<p align="center"> - Out of the box Gatsby Starter for creating documentation websites easily and quickly. With support for MDX, code highlight, Analytics, SEO and more 🔥 Using the theme: <a href="https://github.com/Rocketseat/gatsby-themes/tree/master/%40rocketseat/gatsby-theme-docs">@rocketseat/gatsby-theme-docs</a> -</p> - -<p align="center"> - <img src="https://img.shields.io/badge/PRs-welcome-%237159c1.svg" alt="PRs welcome!" /> - - <img alt="License" src="https://img.shields.io/badge/license-MIT-%237159c1"> - - <a href="https://twitter.com/intent/follow?screen_name=rocketseat"> - <img src="https://img.shields.io/twitter/follow/rocketseat.svg?label=Follow%20@rocketseat" alt="Follow @rocketseat" /> - </a> -</p> - -## 🚀 Features - -- MDX for docs; -- Fully customizable through the usage of Gatsby Themes (and Theme UI) -- Sidebar customization with Yaml; -- Code highlighting with [prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer) and [react-live](https://github.com/FormidableLabs/react-live) support. Copy code button and option to show line numbers. -- SEO (Sitemap, schema.org data, Open Graph and Twitter tags). -- Google Analytics support; -- Offline Support & WebApp Manifest - -## ⚡️ Getting started - -1. Create the website. - - ```sh - gatsby new rocket-docs https://github.com/rocketseat/gatsby-starter-rocket-docs - ``` - -2. Start developing. - - ```sh - cd rocket-docs - gatsby develop - ``` - -3. Are you ready for launch? - - Your site is now running at `http://localhost:8000` - -## 📄 Docs - -Looking for docs? Check our live demo and documentation [website](https://rocketdocs.netlify.com). - ---- - -Made with 💜 by Rocketseat :wave: [check our community!](https://discordapp.com/invite/gCRAFhc) +Argonne EIC software tutorial etc. -- GitLab