time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (1629B)


      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # Architecture
     22 
     23 > Operating system CPU architecture.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var ARCH = require( '@stdlib/os/arch' );
     31 ```
     32 
     33 #### ARCH
     34 
     35 Operating system CPU architecture.
     36 
     37 ```javascript
     38 console.log( ARCH );
     39 // => <string>
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="examples">
     47 
     48 ## Examples
     49 
     50 <!-- eslint no-undef: "error" -->
     51 
     52 ```javascript
     53 var ARCH = require( '@stdlib/os/arch' );
     54 
     55 if ( ARCH === 'arm' || ARCH === 'arm64' ) {
     56     console.log( 'Running on ARM...' );
     57 } else {
     58     console.log( 'Running on something else...' );
     59 }
     60 ```
     61 
     62 </section>
     63 
     64 <!-- /.examples -->
     65 
     66 * * *
     67 
     68 <section class="cli">
     69 
     70 ## CLI
     71 
     72 <section class="usage">
     73 
     74 ### Usage
     75 
     76 ```text
     77 Usage: arch [options]
     78 
     79 Options:
     80 
     81   -h,    --help                Print this message.
     82   -V,    --version             Print the package version.
     83 ```
     84 
     85 </section>
     86 
     87 <!-- /.usage -->
     88 
     89 <section class="examples">
     90 
     91 ### Examples
     92 
     93 ```bash
     94 $ arch
     95 ```
     96 
     97 </section>
     98 
     99 <!-- /.examples -->
    100 
    101 </section>
    102 
    103 <!-- /.cli -->
    104 
    105 <section class="links">
    106 
    107 </section>
    108 
    109 <!-- /.links -->