work on doc

markdown/bitburner.singularity.gymworkout.md

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [gymWorkout](./bitburner.singularity.gymworkout.md)
+
+## Singularity.gymWorkout() method
+
+If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.
+
+This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.
+
+The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train
+
+<b>Signature:</b>
+
+```typescript
+gymWorkout(gymName: Gym, stat: GymStat): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  gymName | [Gym](./bitburner.gym.md) | Name of gym. You must be in the correct city for whatever gym you specify. |
+|  stat | [GymStat](./bitburner.gymstat.md) | The stat you want to train. |
+
+<b>Returns:</b>
+
+boolean
+
+True if actions is successfully started, false otherwise.
+
+## Remarks
+
+2 GB  Level 1
+