Skip to content

Commit

Permalink
Add Installing and Quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
Thibault Gouala committed Feb 15, 2018
1 parent ff83c18 commit b8669e1
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 4 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions sphinx/source/GettingStarted/Installing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Installing
==========

Package Contents
----------------
Each .unitypackage downloaded from the AssetStore or from the `WellFired <https://www.wellfired.com>`_ website will have
the same contents.

* \/WellFired/WellFired.Peek/Editor
Here you'll find all code related to the .Peek project

Installing
----------

1. Import the .unitypackage into your unity project.
22 changes: 22 additions & 0 deletions sphinx/source/GettingStarted/Quickstart.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Quick Start
===========

1. After installing .Peek, .Peek window is accessible through the menu `Window --> DotPeek` in Unity Editor. Click on it to open .Peek interface.

2. After opening .Peek, open the Setting page. Ensure that `Generate a Build Report after a build is done` is enabled. This will indicate to .Peek that a build report should be generated when Unity finishes a build.
.. image:: Images/GettingGtarted/Settings.png

3. If you wish that at the end of a build .Peek is automatically opened for you, enable the option `Automatically open DotPeek after a build is done`.
.. image:: Images/GettingStarted/RightSettings.png

4. Now you are ready to build. Currently .Peek support generating a report for the platforms Windows, Linux, Mac OS, iOS and Android. Build your project for one of these platforms.

5. At the end of the build, if the option is enabled, .Peek should open by itself. If you did not enable it, then open it through `Window --> DotPeek`.

6. Congratualation ! You generated your first build report ! The left panel of .Peek window contains all the build you generated for your Unity project. Clicking on one of them will open the build report in the right panel.
.. image:: Images/GettingStarted/FirstBuildReport.png

Next Step
=========

In the coming pages, you’ll learn more about .Peek’s User Interface, and how are stored and managed your build reports.
2 changes: 1 addition & 1 deletion sphinx/source/general/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Yes ! And you are strongly recommended to do so. By specifying a path relative t
Can I use .Peek reports outside of .Peek interface
--------------------------------------------------

.Peek reports are in open JSON format. They can be parsed efficiently and used anywhere you find it useful. You could for example render them in your own web interface. .Peek lastest version will always update the older build reports to the newest format, ensuring your build reports stay relevant at any time.
.Peek reports are in open JSON format. They can be parsed efficiently and used anywhere you find it useful. You can for example render them in your own web interface. .Peek lastest version will always update the older build reports to the newest format, ensuring your build reports stay relevant at any time.
14 changes: 11 additions & 3 deletions sphinx/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.Peek Documentation
===================

Welcome to the official documentation for .Peek, a Unity editor tool that allows you to automatically generate a report of the assets included into your builds and keep a eye on the history of the evolution of your project in a nicely integrated and responsive interface.
Welcome to the official documentation for .Peek, a Unity editor tool that allows you to automatically generate a report of the assets included and not into your builds and keep an eye on the evolution of your project assets in a nicely integrated and responsive interface.
We recommend you read the :ref:`introduction page <doc_about_intro>` to get an overview of what this documentation
has to offer.

Expand All @@ -21,8 +21,16 @@ The main documentation for the site is organized into the following sections:
:caption: General
:name: sec-general

general/introduction
general/faq
General/Introduction
General/faq

.. toctree::
:maxdepth: 1
:caption: Getting Started
:name: sec-general

GettingStarted/Installing
GettingStarted/Quickstart

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit b8669e1

Please sign in to comment.